home *** CD-ROM | disk | FTP | other *** search
/ The Essential Home & Business Collection / The Essential Home & Business Collection.iso / 13 / 0 / 5 / WHAT.DOC < prev   
Text File  |  1988-04-01  |  15KB  |  417 lines
  1.  
  2.  
  3.      ╔═══════════════════════════════════════════════════╗
  4.      ║                             ║
  5.      ║  WHAT - The Directory Documentation Utility         ║
  6.      ║  Version 2.13 Copyright (C) by Bill Newell, 1987  ║
  7.      ║                             ║
  8.      ╚═══════════════════════════════════════════════════╝
  9.  
  10.  
  11.  
  12. NOTICE to users of WHAT Version 2.00 !!!!
  13. -----------------------------------------
  14. If you are a user of WHAT Version 2.00, please review the section "Change
  15. History" at the end of this document.  In order to use Version 2.13, you will
  16. have to rename any existing Directory Documentation Files on your system before
  17. starting to use this new version.
  18.  
  19. The Directory Documentation File name that is now used by WHAT is the name of
  20. the directory being processed, appended with a .DIR extension.    For example, if
  21. you are processing a directory called LETTERS, the Directory Documentation File
  22. will be named LETTERS.DIR.
  23.  
  24. You can rename your Directory Documentation Files by using the DOS Rename
  25. command:
  26.  
  27. Example:  RENAME WHAT.DIR LETTERS.DIR
  28.  
  29.  
  30.  
  31. How to use WHAT without reading the documentation:
  32. --------------------------------------------------
  33. If you're like most of us, you down-loaded this program because you wanted to
  34. use it's advertised feature; that is, to be able to add a description to each
  35. entry in one of your sub-directories.
  36.  
  37. What you DON'T want to do, is to have to wade through a pile of documentation
  38. before you figure out out HOW to use this program.
  39.  
  40.  
  41. OK, here's the CONDENSED version of the WHAT Documentation File:
  42.            ---------
  43.  
  44. 1.  Copy the WHAT.COM program to the directory you want to document, or to
  45.     any directory that you can access via the DOS PATH command.
  46.  
  47. 2.  Change to the directory you want to document.  (eg. CD\LETTERS)
  48.  
  49. 3.  Execute WHAT.  (You will be prompted for a description for each entry in
  50.     your directory).
  51.  
  52. 4.  Execute WHAT /A  (You will see all files in your directory with the
  53.     associated description you entered).
  54.  
  55. 5.  Execute WHAT /?  (This will show you the other processing options of the
  56.     WHAT program).
  57.  
  58. 6.  Read the WHAT.DOC file sometime when you have nothing better to do, which is
  59.     an expanded description of the above five steps.
  60.  
  61.  
  62. --------------------------------------------------------------------------------
  63.     DON'T YOU WISH ALL OTHER PROGRAMS CAME WITH A CONDENSED VERSION OF THE
  64.     DOCUMENTATION ????            (Maybe we can set a trend here ??....)
  65. --------------------------------------------------------------------------------
  66.  
  67.  
  68.  
  69. Why use WHAT ?
  70. --------------
  71. In the dark about some of the files contained in your directory ?  Ever
  72. wonder what that obscure program you added in 1984 called FROG.COM does, and
  73. where it came from in the first place ?  Are you afraid to execute that
  74. program CRASH.EXE, because you've forgotten what it does...., but you don't
  75. want to delete it because it really may be useful ?  Ever wish DOS filenames
  76. were longer ?  Or wish DOS gave you a facility for keeping track of the
  77. contents in your sub-directories ?
  78.  
  79. If you've answered YES to any of these questions, then WHAT is for you !!
  80.  
  81. NOW THESE PROBLEMS ARE GONE !!
  82.  
  83. WHAT is a neat, fast program which allows you to give descriptions to programs
  84. out there in your directories.    You can view and update them anytime you want.
  85.  
  86. You can also use WHAT to search your directory for the occurrence of any
  87. literal.  For example, executing WHAT PRINTER will display all directory entries
  88. that contain the literal PRINTER in the description you gave to your files,
  89. using WHAT.
  90.  
  91. The best news is that you can use this program and not pay for it unless you
  92. like it !  I wrote this program to solve my own problems with keeping track of
  93. the contents of my sub-directories, and I want to share it with you.  If you
  94. like it and use it, then please send 15 bucks to keep me encouraged to write
  95. more programs, and to reinforce my faith in the "Shareware" concept of
  96. distributing software.
  97.  
  98. I hope you enjoy this program and find it useful.
  99.  
  100.  
  101. Sincerely,
  102.  
  103.  
  104. Bill Newell
  105. 249 Foxden Circle
  106. Naples, FL 33942
  107.  
  108.  
  109.  
  110. What is WHAT ?
  111. --------------
  112. WHAT is a utility program designed to help you keep track of the contents of
  113. your disk directories.    It will work with DOS 2.0 or later.
  114.  
  115. The WHAT program maintains a documentation file for each of your diskettes, or
  116. disk directories; and you can attach a description (up to 61 characters) to
  117. each entry in your directory.
  118.  
  119. Once you have set up your initial Directory Documentation File using WHAT,
  120. then you can use WHAT's search facility to display your description records;
  121. either all of them, or a sub-set based upon a search argument that you
  122. specify.
  123.  
  124. Since the Directory Documentation File is an ASCII file, you can also use your
  125. favorite text editor to access/maintain this file.
  126.  
  127.  
  128.  
  129. The WHAT help screen:
  130. ---------------------
  131. There are no complicated commands to remember; anytime you forget what
  132. options are available to you, just enter WHAT /? and the following help
  133. screen will appear:
  134.  
  135.  
  136.  
  137. >>>> WHAT - The Directory Documentation Utility <<<<
  138.  
  139.  
  140. Ways to use WHAT:
  141. -----------------
  142. WHAT           -  Prompts you for any missing descriptions.
  143.  
  144. WHAT /U        -  Prompts you to Update the descriptions of ALL
  145.               your files.
  146.  
  147. WHAT /U FileName   -  Prompts you for descriptions of your files,
  148.               starting at FileName.
  149.  
  150. WHAT /A        -  Displays all records in your Directory Documentation
  151.               File.
  152.  
  153. WHAT XXXXX       -  Displays all records containing XXXXX, where
  154.               XXXXX is a sequence of characters (any length),
  155.               appearing in either the filename or description.
  156.  
  157. WHAT /D XXXXX       -  Same as above, but displays only records where
  158.               XXXXX appears in the description.
  159.  
  160. What /?        -  Displays this screen.
  161.  
  162.  
  163.  
  164. Creating/Updating your Directory Documentation File:
  165. --------------------------------------------------
  166. Set your current DOS directory to the sub-directory you want to work with
  167. and then execute WHAT.    If a Directory Documentation File does not exist, then
  168. it will be created, and you are prompted to supply a description for each
  169. entry in your directory.  If a Directory Documentation File does exist, then
  170. it is updated to reflect any deletions or additions made to your directory
  171. since the last time you executed WHAT.    You are prompted for a description
  172. for any added items, as well as for existing entries that do not yet have a
  173. description.
  174.  
  175. Additional processing options are available, such as WHAT /U and WHAT /U
  176. FileName.  Please refer to the Help screen for a description of these
  177. options.
  178.  
  179. When WHAT prompts you for a description, a screen similar to the following
  180. will appear:
  181.  
  182. WHAT - The Directory Documentation Utility
  183. Version 2.13 Copyright (C) by Bill Newell, 1987
  184.  
  185. Reading directory: C:\LETTERS
  186. Sorting directory entries
  187. Processing ┌──────────────────────────────────────────────────────────────╖
  188.        │ Please enter a description for: WHAT.DOC              ║
  189.        │                                  ║
  190.        │ -                                  ║
  191.        ╘══════════════════════════════════════════════════════════════╝
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198. Last Description:  The Directory Documentation Utility
  199.  
  200. Saved Description:
  201.  
  202.  
  203.  F1: Save Desc    F2: Use Saved Desc  F3: Use Last Desc  ─ Esc to quit ─
  204.  
  205.  
  206. Editing keys available when entering a description:
  207. ---------------------------------------------------
  208. The following keys can be used when entering/updating a description:
  209.  
  210. The cursor left, cursor right, backspace, insert and delete keys perform as
  211. you would expect them to.
  212.  
  213. The Home key takes you to the beginning of the description.
  214.  
  215. The End key takes you to the end of the description.
  216.  
  217. The Ctrl-End keys clears the field from the current cursor position to
  218. the end of the field.
  219.  
  220. When you are finished entering the description, pressing the Enter key
  221. updates the Directory Documentation File.
  222.  
  223. Pressing the Esc key processes the remaining file without prompting you for
  224. any more descriptions.    This option is useful when you want to enter
  225. descriptions for just a few files in your directory at a time.
  226.  
  227. There are two additional options on this screen that you may find useful:
  228.  
  229. WHAT displays the "Last Description" it has read.  If you want to use this
  230. as the description for the current entry, then just press F3 (make any
  231. additional changes you want), and then press the Enter key.
  232.  
  233. You can also press F1 to save a "current" description (before you press
  234. Enter), and recall this description anytime by pressing the F2 key.
  235.  
  236. You should run WHAT to update your Directory Documentation Files on a regular
  237. basis.    This will ensure that your file reflects any additions and/or
  238. deletions you have made recently, and also allows you to readily enter
  239. descriptions for any new items while you can still remember what they are.
  240.  
  241.  
  242.  
  243. Using the WHAT search facility:
  244. -------------------------------
  245. Once you have created a Directory Documentation File, then you can use WHAT's
  246. search facility to display your description records.
  247.  
  248. To see all the records in your Directory Documentation File, enter WHAT /A
  249.  
  250. Additional search options are available, such as WHAT XXXXX and WHAT /D
  251. XXXXX.    Please refer to the Help screen for a description of these options.
  252.  
  253. When WHAT has found all the records you requested, you see a screen
  254. similar to this:
  255.  
  256.  
  257.  
  258. WHAT - The Directory Documentation Utility
  259. Version 2.13 Copyright (C) by Bill Newell, 1987
  260.  
  261. Searching for: "WHAT"
  262.  
  263. File Name       D e s c r i p t i o n
  264. ------------       ------------------------------------------------------------
  265. WHAT.COM       The Directory Documentation Utility
  266. WHAT.DIR       Documentation file for WHAT
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.    Home End PgUp PgDn  ─ Esc to Quit ─  Sort    Print    3 records  Top of File
  278.  
  279.  
  280. The following keys can then be used to change the display:
  281.  
  282. The cursor up and cursor down keys scroll the display one line at a time.
  283. (The cursor left and cursor right can also be used, if you prefer.)
  284.  
  285. The Home key displays the first screen of your file.
  286.  
  287. The End key displays the last screen of your file.
  288.  
  289. The PgUp/PgDn keys display any preceding/succeeding screens.
  290.  
  291. Press the Esc key to end the program.
  292.  
  293. Pressing S (Sort) asks you whether you want to sort by (N) Name or (D)
  294. Description.  Then Press N or D to sort the records you have selected.    For
  295. users that prefer (F) FileName to (N) Name, pressing the F key also works.
  296. If you are a power-user, and know what it is you want to sort on:  N,D,(or F);
  297. you don't even have to enter the S (for Sort) first.  Just pressing N,D,(or F)
  298. will do just fine.
  299.  
  300. If you want a printout of the records you selected, press P (Print).
  301.  
  302. The remainder of the status line displays the number of records that have
  303. been found, as well as an indication on whether you are at the Top of the
  304. File, Bottom of the File, or somewhere in-between.
  305.  
  306.  
  307. Some Limitations:
  308. -----------------
  309. As with all good things; there are some limitations to the capacities that
  310. WHAT can handle.
  311.  
  312. Using WHAT to maintain your Directory Documentation Files, you are limited to
  313. 1,000 directory entries.  Nothing bad will happen if you have more than
  314. that, but just the first 1,000 entries will be processed.  (If you have more
  315. than 1,000 entries, you should REALLY consider re-organizing your disk, as
  316. your DOS access time will be abominable !!)....
  317.  
  318. WHAT keeps all "selected" records in memory (for fastest access).  When you
  319. use WHAT's search facility there is a limit of 400 records that can be
  320. stored during any one search.  Again, nothing nasty will happen if WHAT
  321. finds more than 400 matching entries, but only the first 400 will be
  322. displayed.
  323.  
  324. In addition, should more than 400 entries match your search criteria, you
  325. will see a blinking message on the status line, to make you aware that the
  326. maximum number of selected records has been exceeded.
  327.  
  328.  
  329.  
  330. Error Messages:
  331. ---------------
  332. I have gone to great pains to make this program as user-friendly as
  333. possible.  When an error is detected, you are given a message describing the
  334. probable cause of the error and the remedy to correct the error.
  335.  
  336.  
  337.  
  338. Warranty & Other Stuff:
  339. -----------------------
  340. This program is provided "as is" without warranty of any kind, either
  341. expressed or implied.
  342.  
  343. If you find this program useful, and you believe in the "Shareware" concept
  344. of distributing software, a small contribution ($15 suggested) would be
  345. greatly appreciated.  It is only with the support of users that software
  346. such as this can be developed, as well as to encourage program authors to
  347. write more nifty stuff !!
  348.  
  349.  
  350. Please send all correspondence and contributions to:
  351.  
  352.     Bill Newell
  353.     249 Foxden Circle
  354.     Naples, FL 33942
  355.  
  356.  
  357.  
  358.  
  359. Change History:
  360. ---------------
  361. Version 1.00   1986    This was a prototype version of WHAT.  This version was
  362.                never distributed.
  363.  
  364. Version 2.00  3-29-87  WHAT was completely rewritten, and utilizes a number of
  365.                Assembler routines for quick performance.
  366.                Distributed as Shareware.
  367.  
  368. Version 2.10  7-20-87  The following changes, suggested by users of Version 2.00
  369.                have been made:
  370.  
  371.                If a Directory Documentation File does not exist in the
  372.                directory being processed, a message is displayed
  373.                informing the user that such a file is going to be
  374.                created.  The user then has the option of continuing, or
  375.                ending the program.
  376.  
  377.                In Version 2.00, all Directory Documentation Files were
  378.                named WHAT.DIR.    The name that is used now is the name
  379.                of the directory being processed, appended with a .DIR
  380.                extension.  For example, if you are processing a
  381.                directory called LETTERS, the Directory Documentation
  382.                File will be named LETTERS.DIR.    If your directory name
  383.                already has an extension, such as LETTERS.LIB, WHAT will
  384.                still use the main directory name and the Directory
  385.                Documentation File will still be called LETTERS.DIR.
  386.  
  387.                If you are processing the root directory of your disk or
  388.                diskette, the Directory Documentation File will be called
  389.                ROOT.DIR.
  390.  
  391. Version 2.11  8-03-87  Fixes a minor bug that would report a sequence error when
  392.                processing a V2.00 Directory Documentation File the first
  393.                time with WHAT V2.10
  394.  
  395.                As an aside:  Should you ever encounter the message
  396.                "... description file is not in sequence by file name";
  397.                remove all heading/footing lines from your Directory
  398.                description file and try the WHAT program again. That is,
  399.                remove the records at the beginning and end of the file,
  400.                that are not description records for the files in your
  401.                directory.
  402.  
  403.                This error is usually caused by users editing their
  404.                description files, and changing the heading/footing
  405.                records so that the WHAT program can no longer recognize
  406.                them as such.
  407.  
  408. Version 2.12 10-20-87  Fixes bug that caused a BASIC 5 Error when attempting to
  409.                use the "Ins" (Insert) key, when the cursor was at the
  410.                last position of the description field.
  411.  
  412. Version 2.13  3-31-87  Added the "How to use WHAT without reading the
  413.                documentation" section to the documentation file.
  414.  
  415.  
  416.  
  417.